home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / games / squad146.zip / SYSOP.DOC < prev    next >
Text File  |  1996-08-22  |  18KB  |  425 lines
  1. COP SQUAD! v.1.xx    SysOp Documentation
  2.  
  3. COP SQUAD is a live door game which is both simple to set up and simple to
  4. use (both for the sysop and the BBS user).
  5.  
  6. I will go more into the setup and use of the game in a little bit. First
  7. however, the obligatory paragraphs...
  8.  
  9. COPYRIGHT NOTICE
  10. ----------------
  11.  
  12. COP SQUAD is a copyrighted program being distributed under the shareware
  13. concept of marketing. As such, you may use COP SQUAD for a period of 30
  14. days without registering the software. After the 30 day evaluation period,
  15. you must register your copy of COP SQUAD or discontinue using it.
  16.  
  17. WARRANTY
  18. -----------------
  19.  
  20. COP SQUAD is distributed without any warranty, either expressed or implied.
  21. In no event will Jan Ferguson or Phoenix Data Systems, Inc. be liable to you
  22. for any damages (either hardware or software) including any loss of profits,
  23. lost savings or other incidental or consequential damages arising out of
  24. your use of, misuse of or inability to use the program, even if Jan Ferguson
  25. or an authorized representative of Phoenix Data Systems, Inc. has been
  26. notified of the possibility of such damages. Jan Ferguson and/or Phoenix Data
  27. Systems, Inc. will not be liable for any such claim by any other party. The
  28. only thing COP SQUAD is warranted to do is take up space on your disk or other
  29. storage facility.
  30.  
  31. Having said all of the above...let's continue.
  32.  
  33. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  34.  
  35. CONFIGURING "COP SQUAD"
  36. ------------------------
  37.  
  38. COP SQUAD is simple to set up and will work with most BBS door data drop
  39. files. The following are the setup steps:
  40.  
  41. 1) Create a separate directory for COP SQUAD on your hard drive
  42. (i.e., c:\wc40\doors\squad) and unzip the archive into it. The archive should
  43. include the following files:
  44.  
  45.         SQUAD.EXE      ( main executable file         )
  46.         SQUAD.CFG      ( sample .cfg file             )
  47.         SYSOP.DOC      ( this text file               )
  48.         SUBJECT.DAT    ( criminal data file           )
  49.         CRIMES.DAT     ( crimes data file             )
  50.         INSTRUCT.TXT   ( instructions text file       )
  51.         P_&_P.TXT      ( policy & procedure text file )
  52.         EXAMS.DAT      ( promotional exam data file   )
  53.  
  54. If any of the above files are missing, current copies of the program can be
  55. downloaded from the Phoenix BBS at:
  56.  
  57.  1) Node 1 : (954) 572-6086
  58.  2) By file request from 1:369/101 by nodelisted Fidonet nodes with the
  59.     magic name of SQUAD.
  60.  
  61. 2) Edit the configuration file with any ASCII text editor with the following
  62. format. You can also use the Setup Utility in the COPUTILS.EXE program.
  63.  
  64. Line 1 : Door Data File Type
  65. Line 2 : Path to your door data file(s)
  66. Line 3 : BBS name
  67. Line 4 : SysOp's Full name
  68. Line 5 : Locked Baud Rate
  69. Line 6 : Path to place your ANSI bulletin
  70. Line 7 : Path to place your ASCII bulletin
  71. Line 8 : Number of days of player inactivity for player to be deleted
  72.  
  73. As illustrated above, the door's data file type is specified in line 1 and
  74. can be of the following types... PCB for PCBoard, GAP for GAP (DOOR.SYS),
  75. SF for Spitfire, RBBS for RBBS, WC for Wildcat! (callinfo.bbs), TRIBBS for
  76. TriBBS, or WWIV for WWIV. The path for your door's data file in Line 2
  77. should only include the path. DO NOT include the door's drop file.
  78.  
  79. Correct: C:\WC40\WCWORK\NODE1\   <--  trailing backslash *IS* needed
  80.  
  81. Incorrect: C:\WC40\WCWORK\NODE1\DOOR.SYS
  82.  
  83. The sysop's name in line 4 can now be any name or handle you wish to use.
  84. In the original version(s) of COP SQUAD it was necessary to have the name
  85. be the same as your BBS log on name. This is no longer necessary. All
  86. utility modules are now located in the COPUTILS.EXE program.
  87.  
  88. The locked baud rate is specified in line 5. If you do not lock your serial
  89. port you must specify a zero (0) for the locked baud rate. NOTE: Although
  90. many door formats do pass the locked baud rate in the door data files, some
  91. older formats such as RBBS do not. For uniformity, COP SQUAD requires that
  92. your specify the locked baud rate in line 5 and it ignores any value passed
  93. in the door data files.
  94.  
  95. Lines number 6 and 7 *MUST* have something written on them. If you wish to
  96. include an ANSI bulletin place the FULL path and file name for the ansi
  97. bulletin on line #6. If you DO NOT wish to have an ansi bulletin, write NONE.
  98. Complete line 7 in a similar fashion by placing the FULL path and file name
  99. for your ascii bulletin, if wanted. If none is wanted write NONE.
  100. If no bulletins are wanted AT ALL, write NONE on line 6 and line 7.
  101.  
  102. The following is a sample door configuration file:
  103.  
  104. GAP
  105. C:\WC40\WCWORK\NODE1\
  106. The Phoenix BBS
  107. Jan Ferguson
  108. 38400
  109. c:\wc40\bull\bull1.scr  <-- Enter NONE on Line 6 if no ansi bulletin is wanted
  110. c:\wc40\bull\bull1.bbs  <-- Enter NONE on Line 7 if no ascii bulletin is wanted
  111. 0   <-- Enter a zero (0) if you don't want players to be deleted for inactivity
  112.         Any other number for that number of days of inactivity.
  113.  
  114. RUNNING COP SQUAD
  115. ----------------------
  116.  
  117. COP SQUAD can be run by creating a very simple batch file in your BBS to
  118. call the door. The command line will look similar to the following:
  119.  
  120. SQUAD SQUAD.CFG
  121.  
  122. The configuration file can be any name of your choosing as long as the file
  123. extension ends in .cfg and is included immediately after the executable file
  124. on the command line.
  125.  
  126. For your convenience in setting up the door, COP SQUAD can be run locally
  127. without a door data file (handy for you to use the door without logging on to
  128. the BBS) by specifying /L after the configuration file parameter in the DOS
  129. command line. COP SQUAD will request the sysop to enter his/her name before
  130. running the door.
  131.  
  132. Non-standard IRQ's can be used with COP SQUAD by specifying the IRQ number
  133. after the "config" parameter in the command line used to run the door.
  134. Here's an example:
  135.  
  136. SQUAD config irq
  137.  
  138. While the game is running, COP SQUAD will keep track of the time since the
  139. last key stroke. If there is no input from the user for a period of 5 minutes
  140. it will exit them from the game back to the BBS. Likewise, if the user drops
  141. carrier from inside the game, COP SQUAD will detect the dropped carrier and
  142. will close all it's files and exit gracefully. There is no need for any type
  143. of carrier watchdog program with COP SQUAD.
  144.  
  145.  
  146. SPECIAL KEYS for the SYSOP
  147. ----------------------------
  148.  
  149. While COP SQUAD is running, you can press certain keys to perform a variety
  150. of functions. The following is a list of the functions that the COP SQUAD
  151. special keys perform:
  152.  
  153. KEY(s)          FUNCTION
  154.  
  155. HOME            Toggles between user status window and a
  156.                 help display that lists the special keys.
  157.  
  158. F6              Takes 5 minutes away from the caller.
  159.                 NOTE: This will not be returned to the BBS.
  160.  
  161. F7              Gives 5 minutes to the caller.
  162.                 NOTE: This will not be returned to the BBS.
  163.  
  164. F9              Quit the door and return the caller to the BBS.
  165.  
  166. F10             Enter chat mode. Pressing the ESC key exits
  167.                 the chat mode.
  168.  
  169. Alt+D           Drop to DOS.
  170.  
  171.  
  172. SysOp CONFIGURATIONS Menu
  173. --------------------------
  174.  
  175. The SysOp utilities are located in the COPUTILS.EXE program. In this program
  176. a SysOp can set up a configuration file, prepare a REGISTRATION application,
  177. input his/her key code information to generate a SQUAD.KEY file, use the PLAYER
  178. EDITOR, enter SPONSOR information or RESET the game.
  179.  
  180. We, of course, like for our users to help support games they enjoy playing
  181. and the Sponsor information on the Welcome Screen is a little incentive to
  182. keep them (or entice others) to open their wallets to help support the BBS's
  183. they use frequently.
  184.  
  185. The COPUTILS.EXE program will now allow (as compared to versions prior to
  186. version 1.31) ANY SysOp (i.e., married sysops, etc.) to use the PLAYER EDITOR.
  187. This was originally requested by Scott and Cindy Ramer and I have set it up for
  188. folks like them. Now you will have to run the separate program to access the
  189. old "SYSOP MENU" but I feel that you will all like it better this way.
  190.  
  191. NOTE: You can not change the sponsor information in the non-registered
  192. version as it won't show up anyway in the unregistered welcome screen. When
  193. you first run COP SQUAD after registering it will not show any SPONSOR
  194. information. Using SPONSOR INFORMATION in the SysOp Configuration Menu will
  195. create a text file called sponsor.dat in your game directory. As long as that
  196. file is present, it's contents will be read into the "Sponsored by: " line in
  197. the Welcome Screen. Should you decide not to have the game's welcome screen
  198. show the sponsoring user's name, you can either change it to your name or
  199. delete the sponsor.dat file.
  200.  
  201. You can also use the REGISTER APPLICATION option which will create a
  202. registration file ready for printing. Simply answer all the questions and
  203. when you are done you can drop to DOS and use the DOS print or copy command
  204. to type the file named REGISTER.TXT. Simply mail it in with your registration
  205. fee.
  206.  
  207. The game will create the PLAYERS.DAT file (which holds all the player's data
  208. while playing the game).
  209.  
  210.  
  211. REGISTERING COP SQUAD
  212. -------------------------
  213.  
  214. You can complete the registration information by doing the following :
  215.  
  216. You can enter the sysop configuration menu and choose option [R] REGISTRATION
  217. APPLICATION. It will ask you the necessary questions and will create a file
  218. called, REGISTER.TXT.
  219.  
  220. You can then print out the file and mail your completed registration
  221. application along with your registration fee (described below) to:
  222.  
  223. Phoenix Data Systems, Inc.
  224. 2950 N.W. 106 Avenue, Suite #6
  225. Sunrise, Florida  33322-1032
  226.  
  227. Registration Fee Schedule : (Choose *ONE*  ONLY!!)
  228.  
  229. $15 - Regular registered version enabling multi-node support and game play on
  230.       all levels (1 - 13).
  231.  
  232. $20 - Same as above registration but includes also a player editor enabling
  233.       the ability to delete players (without deleting the entire player data
  234.       file) and to make changes to most every field in the player data file
  235.       (i.e., weapons, rank, ammo, protection, etc.).
  236.  
  237. * NOTE * : Florida residents, please add 6% sales tax to above amount (totals
  238.            shown below). THIS IS ** ONLY ** FOR FLORIDA RESIDENTS!!
  239.  
  240. $15 + $0.90 = $15.90 for Level 1 registration if a Florida resident.
  241. $20 + $1.20 = $21.20 for Level 2 registration if a Florida resident.
  242.  
  243.  
  244. You will receive an unlimited use registration number. Simply use the KEY
  245. module in the COPUTILS.EXE program and enter your registration information. The
  246. COP SQUAD program will read this text file and recognize your version as a
  247. registered version of COP SQUAD. You will receive the Basic or Deluxe Version
  248. capabilities as encrypted in your Key Code and they will immediately become
  249. activated. All registered users of COP SQUAD will receive any updates to the
  250. program free of charge for as long as they hold their key and while the game is
  251. being updated (it will evetually be impossible to add any more to the game).
  252. All updated versions will be available from PHOENIX BBS in the Phoenix Programs
  253. file area or by f/req.
  254.  
  255.  
  256. REGISTERED vs. SHAREWARE versions
  257. ----------------------------------
  258.  
  259. The differences between the two versions are minor enough to allow you (and
  260. your users) the ability to get a good feel of how the game works and operates.
  261. Yet, the differences are important enough for the continuation of the game past
  262. the 30 day evaluation period (which after all is what Shareware is all about).
  263.  
  264. Summary of differences in Shareware version:
  265. 1. Flashes "DEMO VERSION" in the "Registered to : " area of the screen.
  266.    Registered version will NOT flash and will show your name and BBS name.
  267. 2. Only allows 6 levels of play.
  268.    Registered version allows full 13 levels of play.
  269. 3. Software "Sponsor" information not available.
  270.    Registered version allows you to display the name of a user who might have
  271.    sponsored the game for the BBS by purchasing it for the sysop.
  272. 4. Must delete the PLAYER.DAT file from DOS to reset the game.
  273.    Registered version allows this quickly from the sysop menu.
  274. 5. Player editor not available (requires Level 2 registration (see above) ).
  275.    Level 2 registered version allows changes to the player.dat file as
  276.    described above.
  277.  
  278.  
  279. MULTI-LINE SETUP
  280. ------------------
  281.  
  282. COP SQUAD does perform file locking and sharing and can be used on multi
  283. line BBS's with two or more players using the game on different nodes at the
  284. same time. To make the game multi-line, simply create a different configur-
  285. ation file for each node (i.e., SQUAD1.CFG for node 1, SQUAD2.CFG for node 2,
  286. etc.). Make sure that your door's data file directory for each node is
  287. specified in line 2. The rest of the file would remain the same. Have your
  288. batch file for that node call up the executable file of SQUAD.EXE along with
  289. the appropriate configuration file for that node.
  290.  
  291.  
  292. SUPPORT
  293. -----------
  294.  
  295. I will give whatever support I can to this game and any other doors I create.
  296. Due to the low cost of the game(s), I cannot give voice support but will answer
  297. any messages addressed to me in the following ways:
  298.  
  299. 1) The Phoenix BBS doors support conference:
  300.    Node 1 : (954) 572-6086
  301.  
  302. 2) FidoNet netmail:
  303.    Jan Ferguson
  304.    1:369/101
  305.  
  306. 3) InterNet address:
  307.    Jan Ferguson
  308.    phoenix@safari.net
  309.  
  310. 4) FAX :
  311.    Jan Ferguson
  312.    (954) 572-8295  and/or  (954) 572-6086 (via BGFax)
  313.  
  314. 5) You can also write me a letter and address it to:
  315.  
  316.    Jan Ferguson
  317.    Phoenix Data Systems, Inc.
  318.    2950 N.W. 106 Avenue, Suite #6
  319.    Sunrise, Florida  33322-1032
  320.  
  321. Thanks for taking the time to evaluate COP SQUAD, and please register it which
  322. will give me the opportunity to upgrade COP SQUAD and also write other BBS door
  323. games and utilities.
  324.  
  325.  
  326.  
  327. SPECIAL NOTES
  328. --------------
  329.  
  330. Player Editor :
  331. ---------------
  332.  
  333. The PLAYER EDITOR is primarily a tool for sysops to use whenever a user
  334. complains that a power failure (or any other unexpected disaster) prevented
  335. them from finishing their game. If the game does not exit normally, their
  336. current score or other accomplishments may not have been recorded to disk.
  337.  
  338. If you want users to actively play this game (and experience shows they WILL
  339. play these types of games), it is HIGHLY RECOMMENDED that you do not use the
  340. player editor to alter your own score or game position unless a problem, as
  341. described above, occurs.
  342.  
  343. This is simply an observation and recommendation and by no means is meant to
  344. infer that it would be used by ANY registered sysop to deliberately win the
  345. game. I just felt morally obligated to mention it in this document.
  346.  
  347. Another note on the PLAYER EDITOR which is extremely important. *DO NOT* run
  348. the Player Editor while a user is playing the game! The Player Editor does an
  349. automatic purge/rewrite routine when it exits. It will re-arrange any user
  350. record numbers when it does this and the current player's data will be written
  351. on top of some other user's record (automatically deleting by overwriting the
  352. other user). When it does all the purging and rewriting it also opens and
  353. closes data files as IT NEEDS TO! Untold of atrocities can occur while someone
  354. playing the game and you are opening and closing data files.
  355.  
  356.  
  357. INSTRUCT.TXT and P_&_P.TXT files:
  358. ---------------------------------
  359.  
  360. You may notice that these files have extra lines in various places when viewed
  361. through a text editor. *DO NOT* (repeat), *DO NOT* alter these files. Even
  362. though they are text files, they are formatted to be read by an internal text
  363. viewer which takes into account the 24th and 25th lines in many comm programs.
  364.  
  365. If you change their formatting, portions of the file will not be able to be
  366. read by your users and they might miss out on valuable information which can
  367. be used in their playing/enjoying the game.
  368.  
  369.  
  370. BRIEFING ROOM BULLETINS
  371. -----------------------
  372.  
  373. Effective with version 1.02 the sysop can define up to 9 custom drawn bulletin
  374. board screens for use in the Briefing Room's [B]rowse the bulletin board
  375. selection. If you do not add any screens the program will use one of the two
  376. default hard-coded bulletins. After you add ANY screens, that screen will be
  377. included in the RANDOM generation of the screens. In other words, your
  378. screen(s) will be chosen randomly from the possible 11 screens available (user
  379. defined maximum of 9 plus the two hard-coded).
  380.  
  381. To include you own screens use an ANSI drawing program and make the screens to
  382. following specifications:
  383.  
  384. * Maximum width of 78
  385. * Maximum length of 20
  386. * DO NOT use animation
  387.  
  388. Name the screen BULLSCR.00x (where "x" is the number of the screen. For
  389. example, if you drew two screens you might name them BULLSCR.001 and
  390. BULLSCR.002 . However you could have also named them, BULLSCR.003 and
  391. BULLSCR.007. As long as the final value in the extension of the file name is
  392. a 1 through 9 the screen will be included in the random showing of the
  393. screens in the [B]rowse the bulletin board selection.
  394.  
  395.  
  396.  
  397.  
  398. ACKNOWLEDGEMENTS
  399. -----------------
  400.  
  401. Thanks to the following people who helped immensely with the development of
  402. this game...
  403.  
  404. My wife, Christine, for her love and support.
  405.  
  406. My beta testers throughout the country.
  407.  
  408. ANSI artists    : Mike Kirkpatrick
  409.                   Carlos Gahette
  410.                   Bob Manapeli
  411.                   John Sprague
  412.  
  413. Randy Hunt and Mark Goodwin for RmDoor (used in the creation of this door).
  414.  
  415. My BBS users for some great ideas.
  416.  
  417. Anyone else I might have missed but who was instrumental in this game's
  418. development....."Thank You!"
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.